Create a Dataflow mapping template
This section contains instructions on how to create mapping templates to load data from Dataflow. Mapping templates establish the correspondence between data contained in imported documents, and variables and settings of
| Option | Description |
|---|---|
| New Template | Creates a new template. |
| Edit Template | Opens a window for template editing. |
| Rename Template | Opens a dialog where you can specify a new name for the selected template. |
| Delete Template | Deletes the selected template. |
| Import Template | Imports the template from a Workflow Template Document. |
| Export Template | Exports the template into a Workflow Template Document. |
To create a new template, select the New Template option from the menu. In the New Template dialog, enter the name in the New Name field. To copy mappings from an existing template, check the Copy from box and select the source template from the list.
To open the new template for editing, select the Edit Template option from the menu. The Template Mapping window will be displayed; it contains two tabs:
On this tab, you need to map Dataflow variables and settings to the corresponding items in
- First, select a Regime which will be used to create projects.
- When you open a new template, it will contain an empty table as shown below.
Note: Advanced users can manually edit the template by checking the Allow manual edit box. This option allows you to edit variable names directly in the table.
- To create a mapping, click on
and the Select Mapping window will be opened as shown below. In the top left corner, choose which type of item you want to map: a user-entered variable from the Regime selected in the Template Mapping window, a project property or a project setting.
Note: You can map only one item at time. After mapping, click OK to return to the Select Mappings tab and click on the pen button in the next table row.
- Depending on the selected item, mapping settings will be displayed in the right-hand pane. For most items, there are several ways to specify those settings, in which case the Value Type field will be displayed (all options are described in the table below). The image below shows a Dataflow variable mapped to a
| Option | Description |
|---|---|
| Import Date | Sets the date on which the import was performed as the item's value. |
| Import User | Sets the name of the user who performed the import as the item's value. |
| User Entered | Opens an appropriate field (text, numeric, etc.) where you can specify the value. |
| Revision Tag | Opens the list of available tags in Dataflow. |
- If you are mapping variables, additional fields may become available depending on the variable type (see the table below).
| Field | Description |
|---|---|
| Load as scalar | Check this box to apply a single value to all periods. |
| Get data from parent entity | Check this box to import values from the document one level higher in the Dataflow hierarchy. If the parent document does not contain the selected variable, an error message will be displayed. |
| Override source units | Check this box to set the unit system and scale. If you leave it unchecked, these settings will be imported from Dataflow. |
| Unit system | Unit system of imported data. |
| Scale size | Unit scale of imported data. |
| Conversion settings | Values can be converted from volume to rate or from rate to volume as required. |
- If you are mapping settings, the full list is given in the table below.
| Setting | Description |
|---|---|
| Econ Limit Calculation Type | Indicates how a project's economic limit is determined. Select a Dataflow variable or manually select an option: Calculated or Specified Date. |
| Econ Limit Min. Months to Evaluate | If you have selected the Calculated option for the Econ Limit Calculation Type setting, specify the minimum number of months |
| Econ Limit Specified Date | If you have selected the Specified Date option for the Econ Limit Calculation Type setting, set the date. Select a Dataflow variable, enter a value manually, use document information (in this case revision date or inflation date) or use the date of the import operation. |
| End Year | End year of imported projects. Select a Dataflow variable, enter a value manually, use document information (in this case revision date or inflation date) or use the date of the import operation. |
| Entity Types | Documents of these types will be imported as projects. Select a Dataflow variable or select the nodes manually. |
| Escalation/Inflation Date | Escalation and inflation date of imported projects. Select a Dataflow variable, enter a value manually, use document information (in this case revision date or inflation date) or use the date of the import operation. |
| Hierarchy Path | If you do not want to import the whole structure of the Dataflow hierarchy, here you can select individual nodes to be imported. Select a Dataflow variable, enter a value manually, use document information (revision, comment, node type and so on), use the date of the import operation or the name of the user who performed it, or use revision tags. |
| Import Condition | Expression which determines whether a document will be imported or not. It is constructed similar to expressions in Dataflow and produces a Boolean result: if the result is TRUE, the document will be imported. |
| Import Duration (Years) | Period for which data will be imported. Select a Dataflow variable, enter a value manually or use document information (in this case a revision number). |
| Import End Date | Select a Dataflow variable, enter a value manually, use document information (in this case revision date or inflation date) or use the date of the import operation. |
| Import Start Date | Select a Dataflow variable, enter a value manually, use document information (in this case revision date or inflation date) or use the date of the import operation. |
| Project Name | Name of the imported project. Use the document's name in Dataflow, select a Dataflow variable, enter a value manually, use document information (revision, comment, node type and so on), use the date of the import operation or the name of the user who performed it, or use revision tags. |
| Scenario Comment 1-5 | Comment in the project. Use the document's name in Dataflow, select a Dataflow variable, enter a value manually, use document information (revision, comment, node type and so on), use the date of the import operation or the name of the user who performed it, or use revision tags. |
| Scenario Weighting | Weighting of the imported scenario if you are planning to use weightings. Select a Dataflow variable or enter a value manually. |
| Start Year | Start year of imported projects. Select a Dataflow variable, enter a value manually, use document information (in this case revision date or inflation date) or use the date of the import operation. |
| Turn on Sensitivities & Weightings | Indicates whether sensitivities and weighting will be used in the imported projects |
- If the
- After you have created the mappings, click on OK to save the mapping and close the Select Mapping window. The new mapping will appear on the Select Mappings tab.
- Now you need to select operations to be performed on values during import. Choose one of the options in the Operation column (the descriptions are given in the table below).
| Operation | Description |
|---|---|
| Add | Adds the imported value to the current value stored in |
| Merge | Merges imported values with existing values. If the imported range contains blanks as well as values, those blanks will be filled with values already contained in |
| Overwrite | Overwrites the current value stored in |
| Subtract | Subtracts the imported value from the value stored in |
| Multiply | Multiplies the imported value by the value stored in |
| Divide | Divides the imported value by the value stored in |
- The Factor column contains factors that will be applied to imported values. Factors are applied regardless of the operation selected in the Operation column. By default, the factor is 1. Factors can be used, for example, if you need to convert values from a custom unit system to a
The Import Working Interest tab
On the Import Working Interest tab you can specify where information about partners' shares is stored. You can use values from Dataflow (check the Use document working interest settings box) or map values manually (see instructions below).
To map working interest:
- Select the category from the Select Category list.
- Click on next to the partner who has a share in this category.
- In the pop-up window, a Dataflow variable where working interest is stored, or enter a value manually.
- If the selected Dataflow variable contains a sequence of working interest values, they will be loaded as reversions; to prevent this, check the Use first value only box.
- Click OK. The pop-up window will be closed and you will return to the Import Working Interest tab.
- If you do not have WI shares for all partners (that is, the total share is less than 100%), you need to select a partner, to whom the remainder will be assigned, by checking the box next to its name in the Remainder of Share column. Note that the remainder has to be allocated even if the variable category is marked as optional in the Regime.
- If you want shares of imported partners to be calculated in projects by default, check the box in the Calculate Partner column.
If the sum of all partners' shares exceeds 100%, only 100% will be loaded: partners whose shares add to less than 100% with the remainder allocated to the partner which has the Remainder of Share box checked.
Example: In the Dataflow document, Company A has 45% and Company B has 65%. In the mapping template, both partners are mapped with the remainder allocated to Company C. As the total share is 115%, in the loaded project Company A will have 45% (it is less than 100%) and Company C will have 55%. Company B will be omitted as its share will bring the total to over 100% but, since the total cannot be less than 100%, Company C will be included with the remaining 55% allocated to it.